/*
 * OREKIT-X
 * Copyright 2002-2008 CS Communication & Systemes
 * 
 * Parts of this software package have been licensed to CS
 * Communication & Systemes (CS) under one or more contributor license
 * agreements.  See the NOTICE file distributed with this work for
 * additional information.
 *  
 * This is an experimental copy of OREKIT from www.orekit.org.
 * Please use the original OREKIT from orekit.org for normal work
 * unrelated to this research project.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License.  You
 * may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */
package ore.forces.drag;

import java.io.Serializable;

import ore.time.AbsoluteDate;


/** 
 * Solar activity data compatible with DTM2000 Atmosphere model.
 *
 * This model needs mean and instantaneous solar flux and geomagnetic incides to
 * compute the local density. Mean solar flux is (for the moment) represented by
 * the F10.7 indices. Instantaneous flux can be setted to the mean value if the
 * data is not available. Geomagnetic acivity is represented by the Kp indice,
 * which goes from 1 (very low activity) to 9 (high activity).
 * 
 * All needed solar activity data can be found on the <a
 * href="http://sec.noaa.gov/Data/index.html"> NOAA (National Oceanic
 * and Atmospheric Administration) website.</a>
 *
 * @author Fabien Maussion
 */
public interface DTM2000InputParameters
    extends java.io.Serializable
{

    /** 
     * @return The available data range minimum date.
     */
    public AbsoluteDate getMinDate();

    /** 
     * @return The available data range maximum date.
     */
    public AbsoluteDate getMaxDate();

    /** 
     * @param date Current date
     * @return The instantaneous solar flux
     */
    public double getInstantFlux(AbsoluteDate date);

    /** 
     * @param date The current date
     * @return The mean solar flux
     */
    public double getMeanFlux(AbsoluteDate date);

    /** 
     * Get the value of the 3H geomagnetic index.
     * With a delay of 3 hr at pole to 6 hr at equator using:
     * delay=6-abs(lat)*0.033 (lat in deg.)
     * @param date Current date
     * @return The 3H geomagnetic index
     */
    public double getThreeHourlyKP(AbsoluteDate date);

    /** 
     * @param date Current date
     * @return The last 24H geomagnetic index
     */
    public double get24HoursKp(AbsoluteDate date);

}
